home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / FGHELP30.ZIP / FGHELP.DOC next >
Text File  |  1993-11-20  |  11KB  |  295 lines
  1.                                 --------------
  2.                                 Fastgraph/Help
  3.                                 --------------
  4.  
  5.            Copyright 1993 Ted Gruber Software. All rights reserved.
  6.  
  7. Version 3.03b: Wide-area beta version
  8.  
  9. Introduction
  10. ------------
  11.  
  12. Fastgraph/Help is a context-senstive help system that you can use with any DOS
  13. text editor to provide quick assistance when using Fastgraph. It can run as an
  14. ordinary DOS program, or as a resident program (TSR). It features hypertext
  15. jumps and a cut and paste facility. It is provided to Fastgraph customers as
  16. copyrighted freeware.
  17.  
  18. Files
  19. -----
  20.  
  21. Fastgraph/Help is distributed on our bulletin board in the file
  22.  
  23.   FGH303B.ZIP
  24.  
  25. The zip file contains the following files:
  26.  
  27.   FGHELP.EXE  -- help engine
  28.   FGHELP.HLP  -- binary help file
  29.   FGHELP.CFG  -- optional configuration file
  30.   FGHELP.DOC  -- this file
  31.   FILE_ID.DIZ -- BBS file description
  32.  
  33. When you run Fastgraph/Help, if you do not have enough EMS to swap the help
  34. file to memory, a swap file will be created on your disk. This file will
  35. reside in the same directory as FGHELP.EXE.
  36.  
  37.   FGHELP.SWP -- Swap file created by FGHELP.EXE.
  38.  
  39. Installing Fastgraph/Help
  40. -------------------------
  41.  
  42. To install Fastgraph/Help, simply copy the necessary files into a subdirectory
  43. in your path. We recommend you use an existing subdirectory such as C:\FG or
  44. C:\BIN, or, if you prefer, you can create a separate subdirectory for FGHELP
  45. and add it to your path.
  46.  
  47. It is not necessary to set an environment variable for Fastgraph/Help, but it
  48. may be helpful. If you put the binary help file in a subdirectory that is not
  49. in your path, you can use an environment variable to tell Fastgraph/Help where
  50. to look for it:
  51.  
  52.   SET FGHELP=<directory>
  53.  
  54.       where <directory> is the full directory path where the FGHELP.HLP
  55.       file is located.
  56.  
  57. Fastgraph/Help checks the environment, the current directory, the directory of
  58. the help engine, and the path, in that order, to find the binary help file. If
  59. it is unable to find the binary help file, Fastgraph/Help will not run.
  60.  
  61. Starting Fastgraph/Help
  62. -----------------------
  63.  
  64. Fastgraph/help will run as either a stand-alone program or as a TSR. To run
  65. Fastgraph/Help in stand-alone mode, simply type:
  66.  
  67.    FGHELP
  68.  
  69. To load Fastgraph/Help as a swappable TSR, type:
  70.  
  71.    FGHELP /S
  72.  
  73. When running in TSR mode, a small kernel of the program is loaded in
  74. conventional memory. The remainder of the program is loaded into expanded or
  75. extended memory, provided enough memory is available to do so. If there is
  76. not enough expanded or extended memory, the non-kernal portion of the program
  77. is swapped to disk.
  78.  
  79. If you prefer, you can force Fastgraph/Help to swap to disk. This will be
  80. slower, but it will free up your EMS and XMS memory for other uses. To force
  81. disk swapping, type:
  82.  
  83.    FGHELP /D
  84.  
  85. To unload Fastgraph/Help, type:
  86.  
  87.    FGHELP /U
  88.  
  89. This will remove Fastgraph/Help from RAM and also delete the current swap
  90. file.
  91.  
  92. These commands only work from the DOS command line. Do not try to load or
  93. unload Fastgraph/Help as a TSR when shelled from another program or while in
  94. Windows.
  95.  
  96. As an added safety feature, Fastgraph/Help cannot be loaded twice. If you try
  97. to load it a second time, you will receive a simple warning message.
  98.  
  99. Running Fastgraph/Help
  100. ----------------------
  101.  
  102. When Fastgraph/Help is loaded into RAM in TSR mode, you can make it pop up
  103. over your other applications. For example, you can make Fastgraph/Help pop up
  104. over your editor or compiler IDE. To cause it to pop up, you must press the
  105. hot key. The default hot keys are as follows:
  106.  
  107.    <Alt><LeftShift><H>  -- pop up on the FGHELP topic index
  108.    <Alt><LeftShift><S>  -- pop up on context-sensitive help
  109.  
  110. The context-sensitive help feature is nifty. Suppose you can't remember what
  111. parameters to pass to fg_showpcx. You can put your cursor anywhere under the
  112. letters in "fg_showpcx" and press CTRL-F1. Fastgraph/Help will pop up the
  113. description of fg_showpcx. In other words, you will receive immediate help,
  114. you don't have to go through the menus to find the topic you have a question
  115. about.
  116.  
  117. Navigating Fastgraph/Help
  118. -------------------------
  119.  
  120. When in Fastgraph/Help, the following keys will be active:
  121.  
  122.    <F1>           display the topic index
  123.  
  124.    <Alt><F1>      display the previous topic
  125.  
  126.    <F7>           mark the beginning of a block
  127.  
  128.    <F8>           mark the end of a block
  129.  
  130.    <Alt><P>       paste the marked block into your editor (TSR version)
  131.                   or text file (non-resident version)
  132.  
  133.    <Tab>          move to next cross reference topic, if there is one
  134.  
  135.    <Shift><Tab>   move to previous cross reference topic, if there is one
  136.  
  137.    <Ctrl><L>      find next topic match in context-sensitive mode
  138.  
  139.    <Esc>          exit the current help window, or if at the topic index,
  140.                   exit Fastgraph/Help
  141.  
  142.    <Alt><X>       exit Fastgraph/Help
  143.  
  144. Context-Sensitive Help
  145. ----------------------
  146.  
  147. Context-sensitive help will search for the best match on a partial reference.
  148. For example, if you type "fg_cl" and hit the context-sensitive hot key, and
  149. you will get the reference to fg_clipmask. Pressing <Ctrl><L> several times
  150. will pop up fg_clpimage, fg_cliprect, and fg_clprectw. Fastgraph/Help will
  151. cycle through the available choices. This is helpful when you can't remember
  152. the exact spelling of a Fastgraph function. If you can remember the first four
  153. letters, Fastgraph/Help will tell you the rest.
  154.  
  155. Cut and Paste
  156. -------------
  157.  
  158. Perhaps one of the most useful operations in Fastgraph/Help is the ability to
  159. cut and paste text from the help system to the underlying text editor.
  160.  
  161. Cut and paste is available in both the resident and non-resident versions.
  162. However, it is implemented differently in each. In the resident version, you
  163. can paste the text directly to your underlying text editor. In the
  164. non-resident version, it gets appended to a text file.
  165.  
  166. Cut and Paste (resident mode)
  167. -----------------------------
  168.  
  169. To cut and paste, you must first mark the desired block of text. Use the F7
  170. key to begin marking the text. Use F8 to mark the end of the text. The marked
  171. text is shown highlighted in red. If you want a different block of text, press
  172. F7 and F8 again. When you have successfully highlighted the desired block of
  173. text, press
  174.  
  175.    <Alt><P>
  176.  
  177. This will cause Fastgraph/Help to exit from popup mode and return to the
  178. background. The highlighted text will then appear in whatever program is now
  179. in the foreground, such as your editor, word processor, or IDE.
  180.  
  181. For pasting to your editor, we recommend you turn auto-indenting off.
  182. Otherwise, the text will gradually be seen to indent after each line.
  183.  
  184. Cut and Paste (non-resident mode)
  185. ---------------------------------
  186.  
  187. To cut and paste in non-resident mode, first mark the text using F7 and F8 as
  188. above. Then press
  189.  
  190.    <Alt><P>
  191.  
  192. The desired text will be written to a text file called
  193.  
  194.    FGHELP.TMP
  195.  
  196. This is a temporary ASCII file. It will show up in your current directory.
  197. You may edit this file or copy it into other files. After you are done using
  198. it, you will probably want to delete it.
  199.  
  200. SideKick
  201. --------
  202.  
  203. Borland's SideKick can create problems for other TSRs. Fastgraph/Help avoids
  204. these problems by first checking to see if SideKick is in memory. If it is,
  205. Fastgraph Help tries to patch the copy of SideKick that is in memory so that
  206. other TSRs can be loaded safely after SideKick. However, a patched copy of
  207. SideKick is not able to keep from loading it twice.
  208.  
  209. Fastgraph/Help also is able to detect the presence of SideKick Plus. However,
  210. SideKick Plus is normally more well-behaved than SideKick, so you should
  211. almost always be able to safely load a TSR after SideKick Plus.
  212.  
  213. Configurable HotKeys
  214. --------------------
  215.  
  216. Fastgraph/Help can be activated with two hotkeys, depending on how you want to
  217. use it. By default these keys are set at
  218.  
  219.    <Alt><LeftShift><H> master topic index, and
  220.    <Alt><LeftShift><S> for context-sensitive help.
  221.  
  222. We realize that these hotkeys may not be to your liking, so a mechanism to
  223. customize these is available.
  224.  
  225. You can create a configuration file called FGHELP.CFG. Fastgraph/Help will
  226. look for this file when you load the program. Once the program is resident,
  227. you must first unload it and then reload it before any changes to the
  228. configuration file are recognized.
  229.  
  230. To do this, you need to have two lines in the configuration file. The first
  231. line describes the hot key for popping up the topical index. The second line
  232. describes the context-sensitive hot key. TSRs are normally activated by a
  233. combination of keys pressed simulataneously. For Fastgraph/Help, a hot key is
  234. really a combination of a single key that is pressed along with one or more
  235. shift keys (Ctrl, Alt, LeftShift, RightShift, etc.).
  236.  
  237. The following chart show numeric values of the shift keys that are used in the
  238. configuration file:
  239.  
  240.    Value        Hot Key
  241.  
  242.    0x0800       Alt key
  243.    0x0400       Ctrl key
  244.    0x0200       Left Shift key
  245.    0x0100       Right Shift key
  246.    0x00xx       Scan code for main key
  247.  
  248. To produce a hot key for <Ctrl><F1>, you would find that 0x0400 represents the
  249. <Ctrl> key, and 0x003B represents the <F1> key. Combined, you get a value of
  250. 0x043B. For <LeftShift><F1>, you would get a hot key combination of 0x023B.
  251. Therefore, the configuration file looks like this:
  252.  
  253.    Line 1:   0x043B
  254.    Line 2:   0x023B
  255.  
  256. Just create this file with your favorite text editor, and put it in the same
  257. directory as FGHELP.EXE.
  258.  
  259. Fine Print
  260. ----------
  261.  
  262. Fastgraph/Help is provided as is, without any warranties, express or implied
  263. or otherwise. It is copyrighted freeware, which means you may use it without
  264. charge. You may give copies of this program to your friends, and you may
  265. upload it to bulletin boards and online services. You may not sell this
  266. program or include it in any catalog or CD-ROM distribution without the
  267. express written permission of Ted Gruber Software.
  268.  
  269. Acknowledgements
  270. ----------------
  271.  
  272. Fastgraph/Help was written by:
  273.  
  274.    Mike Stephenson
  275.    KRC Technologies
  276.    204 S Nardo Ave
  277.    Solana Beach, CA 92075-2023
  278.    (619) 259-5225
  279.  
  280. KRC Technologies does computer consulting and custom software on a work for
  281. hire basis.
  282.  
  283. Fastgraph was written by:
  284.  
  285.    Ted Gruber Software
  286.    PO Box 13408
  287.    Las Vegas, NV 89112-1408
  288.    (702) 735-1980 voice
  289.    (702) 796-7134 bbs
  290.    (702) 735-4603 fax
  291.  
  292. Fastgraph is a programmer's graphics library useful for writing games and
  293. other graphics application. For more information about Fastgraph, including a
  294. shareware evaluation kit, contact Ted Gruber Software.
  295.